Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update default values and descriptions for Key Vault on API Version 2024-11-01 #31713

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Update default values and descriptions for Key Vault on API Version 2024-11-01 #31713

wants to merge 12 commits into from

Conversation

FRL200
Copy link
Member

@FRL200 FRL200 commented Dec 2, 2024

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

Fernando Rauseo Landa and others added 5 commits November 26, 2024 10:27
Copy files from stable/2023-07-01
b7298bf 
Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.
Update version to stable/2024-11-01
315e54b 
Updated the API version from stable/2023-07-01 to stable/2024-11-01.
Added tag for 2024-11-01 in readme file
3511f6c
Removed unnecessary folder
cd1e0d8
@FRL200
Update default values and descriptions for Key Vault (#31683)
db48b51 
* Initial Changes to Spec

* Prettier ran

* Ran prettier

---------

Co-authored-by: Fernando Rauseo Landa <[email protected]>
@FRL200 FRL200 requested review from heaths and jlichwa as code owners December 2, 2024 17:28
@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Dec 2, 2024 •
edited
Loading

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Dec 2, 2024 •
edited
Loading

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/keyvault/armkeyvault https://apiview.dev/Assemblies/Review/3db6674029d04e7db876e72a8c438a25?revisionId=cfdbf753a1be4660b569f2ca1f44f673
.Net Azure.ResourceManager.KeyVault https://apiview.dev/Assemblies/Review/d8314e8843874af79d02de87269e9607?revisionId=7ff266b7d6f5430ca8f4d275c0590213
Java azure-resourcemanager-keyvault-generated https://apiview.dev/Assemblies/Review/590206846118422ca4261d2c2c961fb5?revisionId=e1b2e425dfd54908bb231507630be1f9
JavaScript @azure/arm-keyvault https://apiview.dev/Assemblies/Review/8de2ee660a1e46cd85946f2304f47b94?revisionId=7010724e85974be79b75657196c70390
Python azure-mgmt-keyvault https://apiview.dev/Assemblies/Review/48ea69dc4f6940b2a9442b5fc597eb57?revisionId=3a88fa0bd95a4beab35f90a00914ebbc

@azure-sdk
Copy link
Collaborator

API change check

APIView has identified API level changes in this PR and created following API reviews.

Microsoft.KeyVault

@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required new-api-version NotReadyForARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager labels Dec 2, 2024
@azure-sdk azure-sdk mentioned this pull request Dec 2, 2024
Draft
@FRL200 FRL200 added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Dec 2, 2024
This was referenced Dec 2, 2024
Draft
Draft
Draft
Draft
Draft
@JeffreyRichter JeffreyRichter added the BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. label Dec 2, 2024
@FRL200
Copy link
Member Author

FRL200 commented Dec 2, 2024

/azp run

@azure-pipelines Azure Pipelines
Copy link

Azure Pipelines successfully started running 3 pipeline(s).

@AzureRestAPISpecReview AzureRestAPISpecReview added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 2, 2024
@gary-x-li gary-x-li added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Dec 4, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 4, 2024
@FRL200
Copy link
Member Author

FRL200 commented Dec 5, 2024

@microsoft-github-policy-service agree company="Microsoft"

@FRL200
Copy link
Member Author

FRL200 commented Dec 6, 2024

/azp run

@azure-pipelines Azure Pipelines
Copy link

Azure Pipelines successfully started running 3 pipeline(s).

@gary-x-li gary-x-li added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review labels Dec 6, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 6, 2024
@gary-x-li gary-x-li added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gary-x-li gary-x-li gary-x-li approved these changes

@heaths heaths Awaiting requested review from heaths heaths is a code owner

@jlichwa jlichwa Awaiting requested review from jlichwa jlichwa is a code owner

Assignees
No one assigned
Labels
ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required KeyVault new-api-version PublishToCustomers Acknowledgement the changes will be published to Azure customers. ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@FRL200 @azure-sdk @gary-x-li @JeffreyRichter @AzureRestAPISpecReview @Cherrett